Split godoc into separate packages #311
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #311 +/- ##
=======================================
Coverage 94.82% 94.82%
=======================================
Files 46 46
Lines 8951 8951
=======================================
Hits 8488 8488
Misses 361 361
Partials 102 102 ☔ View full report in Codecov by Sentry. |
ewanharris
commented
Nov 10, 2023
| // // handle err | ||
| // } | ||
| // | ||
| // [management client docs]: https://pkg.go.dev/github.com/auth0/go-auth0/management |
There was a problem hiding this comment.
I'm not super thrilled about having to link to pkg.go.dev directly but I'm not sure the doc links support linking like I want to here (i.e to the top level docs)
There was a problem hiding this comment.
Would a relative link work?
There was a problem hiding this comment.
Unfortunately not, we can't use HTML in the docs and the URL support only seems to support full URLs rather than relative.
Widcket
reviewed
Nov 10, 2023
Widcket
reviewed
Nov 10, 2023
Widcket
reviewed
Nov 10, 2023
Widcket
reviewed
Nov 10, 2023
Widcket
approved these changes
Nov 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🔧 Changes
This PR splits the godoc into the separate packages rather than having both the auth and management client documentation in the top level.
Some screenshots of the docs below
Auth0 package page
Authentication package page
Manangement package page
If you want to view this locally then you can install godoc (
go install golang.org/x/tools/cmd/godoc@latest) and then rungodoc -http=:6060in the repo. The documentation will be available onhttp://localhost:6060/pkg/github.com/auth0/go-auth0/📚 References
Fixes #305 alongside the refactor
🔬 Testing
📝 Checklist